/*
 * Copyright 2002-2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.web.context;

import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;

import org.springframework.context.ConfigurableApplicationContext;

/**
 * #Comment#:扩展WebApplicationContext，允许通过配置的方式实例化WebApplicationContext。
 * <p>
 * Interface to be implemented by configurable web application contexts.
 * Supported by {@link ContextLoader} and
 * {@link org.springframework.web.servlet.FrameworkServlet}.
 * 
 * <p>
 * Note: The setters of this interface need to be called before an invocation of
 * the {@link #refresh} method inherited from
 * {@link org.springframework.context.ConfigurableApplicationContext}. They do
 * not cause an initialization of the context on their own.
 * 
 * @author Juergen Hoeller
 * @since 05.12.2003
 * @see #refresh
 * @see ContextLoader#createWebApplicationContext
 * @see org.springframework.web.servlet.FrameworkServlet#createWebApplicationContext
 */
public interface ConfigurableWebApplicationContext extends
		WebApplicationContext, ConfigurableApplicationContext {

	/**
	 * Any number of these characters are considered delimiters between multiple
	 * context config paths in a single String value.
	 * 
	 * @see ContextLoader#CONFIG_LOCATION_PARAM
	 * @see org.springframework.web.servlet.FrameworkServlet#setContextConfigLocation
	 */
	String CONFIG_LOCATION_DELIMITERS = ",; \t\n";

	/**
	 * Set the ServletContext for this web application context.
	 * <p>
	 * Does not cause an initialization of the context: refresh needs to be
	 * called after the setting of all configuration properties.
	 * 
	 * @see #refresh()
	 */
	void setServletContext(ServletContext servletContext);

	/**
	 * Set the ServletConfig for this web application context. Only called for a
	 * WebApplicationContext that belongs to a specific Servlet.
	 * 
	 * @see #refresh()
	 */
	void setServletConfig(ServletConfig servletConfig);

	/**
	 * Return the ServletConfig for this web application context, if any.
	 */
	ServletConfig getServletConfig();

	/**
	 * Set the namespace for this web application context, to be used for
	 * building a default context config location. The root web application
	 * context does not have a namespace.
	 */
	void setNamespace(String namespace);

	/**
	 * Return the namespace for this web application context, if any.
	 */
	String getNamespace();

	/**
	 * Set the config locations for this web application context.
	 * <p>
	 * If not set, the implementation is supposed to use a default for the given
	 * namespace or the root web application context, as appropriate.
	 */
	void setConfigLocations(String[] configLocations);

	/**
	 * Return the config locations for this web application context, or
	 * <code>null</code> if none specified.
	 */
	String[] getConfigLocations();

}
